Skip to content

Comments

docs: full-text index guide (analyzers, search functions, More Like This)#373

Merged
robfrank merged 8 commits intomainfrom
docs/full-text
Feb 20, 2026
Merged

docs: full-text index guide (analyzers, search functions, More Like This)#373
robfrank merged 8 commits intomainfrom
docs/full-text

Conversation

@robfrank
Copy link
Contributor

Summary

  • Adds core-concepts/full-text-index.adoc — comprehensive guide covering multi-property indexing, configurable Lucene analyzers via METADATA, SEARCH_INDEX()/SEARCH_FIELDS(), Lucene query syntax, $score relevance ranking, and the More Like This API (SEARCH_INDEX_MORE()/SEARCH_FIELDS_MORE()/$similarity)
  • Updates sql-create-index.adoc — removes incorrect note that full-text indexes don't support multiple properties; adds cross-reference to new guide
  • Adds 4 search function stubs to sql-functions.adoc (SEARCH_INDEX, SEARCH_FIELDS, SEARCH_INDEX_MORE, SEARCH_FIELDS_MORE)
  • Adds search functions to the SQL overview table in chapter.adoc

Test Plan

  • python3 docs-validator.py passes with no new errors
  • Full-text index guide appears in Core Concepts section
  • Cross-references from CREATE INDEX and sql-functions pages resolve correctly
  • SEARCH_INDEX, SEARCH_FIELDS, SEARCH_INDEX_MORE, SEARCH_FIELDS_MORE appear in the SQL functions overview table

🤖 Generated with Claude Code

robfrank and others added 8 commits February 20, 2026 11:54
…ke This)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… comment, SEARCH_FIELDS_MORE table, JSON quoting

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ference

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…DS_MORE function stubs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…full-text-index

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@gemini-code-assist
Copy link

Summary of Changes

Hello @robfrank, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for ArcadeDB's full-text indexing features. It introduces a detailed guide covering the creation, configuration, and usage of full-text indexes, leveraging Apache Lucene. Additionally, it integrates new SQL functions for performing sophisticated full-text searches and 'More Like This' queries, making these powerful capabilities more accessible and understandable to users.

Highlights

  • New Full-Text Index Guide: A comprehensive guide (full-text-index.adoc) has been added to the core concepts, detailing ArcadeDB's full-text indexing capabilities, including Lucene analyzers, query syntax, relevance scoring, and 'More Like This' functionality.
  • SQL Search Functions: Four new SQL search functions (SEARCH_INDEX(), SEARCH_FIELDS(), SEARCH_INDEX_MORE(), SEARCH_FIELDS_MORE()) have been introduced and documented, enabling advanced full-text queries and similarity searches.
  • Documentation Corrections and Enhancements: The sql-create-index.adoc file has been updated to remove an incorrect note about multi-property full-text indexes and now correctly references the new comprehensive guide. The SQL functions overview table has also been updated to include the new search functions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • src/main/asciidoc/core-concepts/chapter.adoc
    • Included the new full-text-index.adoc guide in the core concepts chapter.
  • src/main/asciidoc/core-concepts/full-text-index.adoc
    • Added a new comprehensive guide covering full-text indexing, Lucene analyzers, search functions (SEARCH_INDEX(), SEARCH_FIELDS(), SEARCH_INDEX_MORE(), SEARCH_FIELDS_MORE()), Lucene query syntax, relevance scoring ($score), and More Like This ($similarity).
  • src/main/asciidoc/core-concepts/indexes.adoc
    • Updated the note about full-text indexes to include a cross-reference to the new dedicated guide.
  • src/main/asciidoc/query-languages/sql/chapter.adoc
    • Added SEARCH_INDEX(), SEARCH_FIELDS(), SEARCH_INDEX_MORE(), and SEARCH_FIELDS_MORE() to the SQL functions overview table.
  • src/main/asciidoc/query-languages/sql/sql-create-index.adoc
    • Removed the incorrect note stating that full-text indexes do not support multiple properties.
    • Added details about Lucene integration and cross-reference to the new full-text index guide for FULL_TEXT index type.
    • Updated the example for searching a full-text index to use SEARCH_INDEX() instead of LIKE.
    • Added a note clarifying that LIKE and ILIKE do not use full-text indexes.
  • src/main/asciidoc/query-languages/sql/sql-functions.adoc
    • Corrected a typo from 'approxmate' to 'approximate' in vectorApproxDistance() description.
    • Added documentation stubs for SEARCH_INDEX(), SEARCH_FIELDS(), SEARCH_INDEX_MORE(), and SEARCH_FIELDS_MORE().
Activity
  • The author, robfrank, created this pull request to add comprehensive documentation for full-text indexing and related SQL functions.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request significantly enhances the documentation for full-text indexing in ArcadeDB. The new full-text-index.adoc guide provides comprehensive coverage of multi-property indexing, configurable Lucene analyzers, search functions (SEARCH_INDEX(), SEARCH_FIELDS(), SEARCH_INDEX_MORE(), SEARCH_FIELDS_MORE()), Lucene query syntax, relevance ranking, and the More Like This API. The updates to existing documentation, such as sql-create-index.adoc and sql-functions.adoc, correctly integrate with and reference the new guide, ensuring consistency and accuracy. The removal of outdated information and the addition of crucial notes (e.g., regarding LIKE and ILIKE not using full-text indexes) are valuable improvements. Overall, the changes are well-executed, clear, and greatly improve the user's understanding of full-text indexing capabilities.

@mergify
Copy link
Contributor

mergify bot commented Feb 20, 2026

🧪 CI Insights

Here's what we observed from your CI run for 9d382f3.

🟢 All jobs passed!

But CI Insights is watching 👀

@robfrank robfrank requested a review from gramian February 20, 2026 13:08
@gramian
Copy link
Collaborator

gramian commented Feb 20, 2026

The new full-text index section is awesome! Great new functionality and cool new info.

@robfrank robfrank merged commit 8c7cbab into main Feb 20, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants